/* Copyright (c) 2008-2012 Peter Palotas
 *  
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *  
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *  
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 */
using System;

namespace AlphaShadow
{
   public class OptionSpec
   {

      public OptionSpec(string name, OptionType valueType, string helpText, bool isRequired, string valueText = null)
      {
         Name = name;
         ValueType = valueType;
         HelpText = helpText;
         IsRequired = isRequired;
         ValueText = valueText;
      }

      public string Name { get; private set; }
      public OptionType ValueType { get; private set; }
      public string HelpText { get; private set; }
      public bool IsRequired { get; private set; }
      public string ValueText { get; private set; }

      public OptionSpec AsRequired()
      {
         return new OptionSpec(Name, ValueType, HelpText, true, ValueText);
      }

      public OptionSpec AsOptional()
      {
         return new OptionSpec(Name, ValueType, HelpText, false, ValueText);
      }

      public OptionSpec WithHelpText(string helpText)
      {
         return new OptionSpec(Name, ValueType, helpText, IsRequired, ValueText);
      }

      public override string ToString()
      {
         return Name;
      }
   }
}
